FlowDocumentState

Manages the state of flow documents within the workflow.

The FlowDocumentState class is responsible for managing and updating the states of documents within a workflow. It inherits from FlowObjectDesigner and provides functionality to update document states either individually or in batch. The class includes properties for managing assigner positions and document collections, along with methods for state updates and logging.

Key features:

• Manages document state updates in a workflow
• Supports batch updates for multiple documents
• Provides logging for state update operations
• Handles document validation before updates
• Implements workflow designer functionality

Properties

Name	Description
Caption	The caption dictionary representing localized captions for the flow object.
Key	A unique identifier for the workflow step.
Name	Name for the workflow step.
WorkflowCodeInstance	The workflow code instance associated with the flow object.
Documents	Gets or sets the list of documents to be updated.
CachedDMObjects	The cached document management objects related to the flow object.
TypeCode	The type code associated with the flow object.
AssignerPositionObjectName	Gets or sets the name of the assigner position object.

Constructors

Name	Description
FlowDocumentState(name, workflowData, workflowCodeInstance)	Constructor for the FlowDocumentState class. Initializes a new instance of the FlowDocumentState class.
FlowDocumentState(name, workflowData, workflowCodeInstance)	Initializes a new instance of the FlowDocumentState class.

Methods

Name	Description
UpdateState(flowDocument, state)	Asynchronously updates the state of a single flow document.
Initialize()	Sets up initial configurations for the flow document state.
UpdateStates()	Asynchronously updates the states of all documents within the flow.

Events

Name	Description
OnAfterExecution(sender, args)	Occurs after the execution of the workflow step.
OnBeforeExecution(sender, args)	Occurs before the execution of the workflow step.